Image Property, SftTreeRowHeader Object


	SftTreeRowHeader.Image Property	Softel vdm, Inc.

Defines the graphic displayed in this row header.

Syntax

Get
	VB.NET	refImageObj = object.Image As SftPictureObject
	VB	Set refImageObj = object.Image As SftPictureObject
	C#.NET	SftPictureObject refImageObj = object.Image;
	VC++	ISftPictureObject* refImageObj = object->Image; ISftPictureObject* refImageObj = object->GetImage();
	C	HRESULT object->get_Image(ISftPictureObject** refImageObj);
	Delphi	refImageObj := object.Image : ISftPictureObject;
Put
	VB.NET	object.Image = refImageObj As SftPictureObject
	VB	object.Image = refImageObj As SftPictureObject
	C#.NET	SftPictureObject object.Image = refImageObj;
	VC++	ISftPictureObject* object->Image = refImageObj; void object->PutImage(ISftPictureObject* refImageObj);
	C	HRESULT object->put_Image(ISftPictureObject* refImageObj);
	Delphi	object.Image := refImageObj : ISftPictureObject;

object

A SftTreeRowHeader object.

refImageObj

Defines the graphic displayed in this row header.

Comments

The Image property defines the graphic displayed in this row header.

When using fixed height items (see Items.Style), all graphics used in a tree control as Image property at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for the row headers, so graphics used as Image property are never clipped vertically. To change the row header graphic size, all row header graphics must be removed first using the RowHeaders.ClearImages method.

When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.

If the image object refImageObj defines a bitmap, the top, left pixel of the bitmap must contain the bitmap's background color. This color will be replaced throughout the bitmap with the actual background (see Bitmap Transparency).

If row headers are disabled (see RowHeaders.Enabled property), the graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired. Individual items may be disabled using the Item.Enabled property.

The RowHeaders.ClearImages method can be used to remove all row header graphics. The Image property can be set to the value Nothing (NULL), which removes the graphic from the row header.

The position of the row header graphic is determined by the RowHeader.ImageHAlign and RowHeader.ImageVAlign properties.